-
Notifications
You must be signed in to change notification settings - Fork 43
🌱 change all 'operator(s)' references to 'extension(s)' in olmv1 commands #227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🌱 change all 'operator(s)' references to 'extension(s)' in olmv1 commands #227
Conversation
b1ee82b
to
88bbd57
Compare
/hold let's get this in after #226 |
Signed-off-by: Artur Zych <[email protected]>
88bbd57
to
66b6f5d
Compare
/unhold |
Use: "install <extension>", | ||
Short: "Install an extension", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use: "install <extension>", | |
Short: "Install an extension", | |
Use: "install <package name>", | |
Short: "Install a cluster extension for a package", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about replacing extension with package name here. I think commonly and for user-facing purposes you'd say you want to install an (cluster)extension?
Package name seems like an implementation detail at this point and at least to me it could confuse people because we'd have crud operations mentioning (cluster)extension and then a package terminology at the root level.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Ankita. Here is my suggestion
Use: "install <cluster extension name>",
Short: "Install a cluster extension",
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a simple rename PR and @LalatenduMohanty is working on install/uninstall commands that this comment touches. How about we have those discussions on that incoming PR where they belong?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with redoing the install help text in the v1 install/uninstall commands PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thats fine. I will fix it in my PR.
Use: "install <extension>", | ||
Short: "Install an extension", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Ankita. Here is my suggestion
Use: "install <cluster extension name>",
Short: "Install a cluster extension",
Warning: this command permanently deletes objects from the cluster. If the | ||
uninstalled Operator bundle contains CRDs, the CRDs will be deleted, which | ||
uninstalled extension bundle contains CRDs, the CRDs will be deleted, which |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should not use extension
and bundle
at the same time. Use of bundle
is associated with registry v1 content but not much with cluster extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is no functional change, it's just one-word rename, so I think bundle(s) are still being used to install operators/extensions.
That said, this is a simple rename PR and @LalatenduMohanty is working on install/uninstall commands that this comment touches. How about we have those discussions on that incoming PR where they belong?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
'Extension(s)' is the target nomenclature for what olmv1 is/will be able to handle and is used throughout our official documentation.
This PR changes all 'operator(s)' references in olmv1 commands and code to reflect that.